home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / checkbox_gc.doc < prev    next >
Encoding:
Text File  |  1999-10-29  |  4.7 KB  |  162 lines
  1. TABLE OF CONTENTS
  2.  
  3. checkbox_gc/--datasheet--
  4. checkbox_gc/CHECKBOX_GetClass
  5. checkbox_gc/--datasheet--                           checkbox_gc/--datasheet--
  6.  
  7.     NAME
  8.         checkbox_gc -- create checkbox BOOPSI objects
  9.  
  10.     SUPERCLASS
  11.         gadgetclass
  12.  
  13.     REQUIRES
  14.         bevel.image, glyph.image
  15.  
  16.     DESCRIPTION
  17.         The checkbox gadget class is used to create toggling check buttons.
  18.         Selection of an associated option is denoted by the gadget being
  19.         "checked", or in other words, containing a checkmark with in the
  20.         checkbox. Unlike GadTools, GA_Height and GA_Width DO NOT specify
  21.         the checkbox size, but rather the entire hit box area which
  22.         includes the text label. The checkbox will maintain its aspect
  23.         ratio when possible.
  24.  
  25.         Advantages that this class provides over the standard gadtools
  26.         checkbox are:
  27.  
  28.          > Supports window relativity.
  29.  
  30.          > Ability to change background pen, text pen, and filltext pen.
  31.  
  32.          > Larger selection area, includes text label area.
  33.  
  34.          > Supports OS 3.0 BOOPSI Gadget HelpTest.
  35.  
  36.          > Aspect adaptive checkbox for any resolution and font.
  37.  
  38.     METHODS
  39.         OM_NEW -- Passed to superclass first, defaults set, then OM_SET.
  40.  
  41.         OM_SET -- Passed to superclass first, then custom tags set & render.
  42.  
  43.         OM_GET -- Returns requested setting or passed to superclass
  44.  
  45.         OM_UPDATE -- Passed to superclass first, then custom tags set & render.
  46.  
  47.         OM_NOTIFY -- Tag set then passed to superclass.
  48.  
  49.         OM_DISPOSE -- Passed to superclass.
  50.  
  51.         GM_DOMAIN -- Returns aspect ratio corrected minimum and maximum
  52.             sizes.
  53.  
  54.         GM_GOACTIVE -- Passed to superclass first, then check activated
  55.  
  56.         GM_GOINACTIVE -- Passed to superclass first, then check deactivated
  57.  
  58.         GM_HANDLEINPUT -- Overrides superclass.
  59.  
  60.         GM_HITTEST -- Overrides superclass, returns GMR_HITTEST.
  61.  
  62.         GM_RENDER -- Renders or erases checkmark glyph.
  63.  
  64.         GM_DOMAIN -- Returns GDOMAIN_MINIMUM, GDOMAIN_NOMINAL and
  65.             GDOMAIN_MAXIMUM dimensions.
  66.  
  67.         GM_KEYACTIVE -- Private method for keyboard control.
  68.  
  69.         GM_KEYINACTIVE -- Private method for keyboard control.
  70.  
  71.     ATTRIBUTES
  72.  
  73.         GA_ID (WORD)
  74.             Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_NOTIFY)
  75.  
  76.         GA_Text (STRPTR)
  77.             Used to set the text label for the checkbox
  78.  
  79.             Defaults to NULL.
  80.  
  81.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  82.  
  83.         GA_TextAttr (struct TextAttr *)
  84.             Used to set the text font to render the checkbox label.
  85.  
  86.             Defaults to RPort->Font, which is often the screen or
  87.             window font.
  88.  
  89.             Applicability is (OM_NEW, OM_SET)
  90.  
  91.         GA_Selected (BOOL)
  92.             Used to set the checkmark state via application control.
  93.  
  94.             Defaults to FALSE.
  95.  
  96.             Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_NOTIFY)
  97.  
  98.         GA_Disabled (BOOL)
  99.             Used to disable the gadget, and render a disable ghost
  100.             pattern of the checkbox.
  101.  
  102.             Defaults to FALSE.
  103.  
  104.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  105.  
  106.         CHECKBOX_TextPen (WORD)
  107.             Pen number used to render the text label.
  108.  
  109.             Defaults to TEXTPEN.
  110.  
  111.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  112.  
  113.         CHECKBOX_BackGroundPen (WORD)
  114.             Pen number used to render the gadget background.
  115.  
  116.             Defaults to BACKGROUNDPEN.
  117.  
  118.             Applicability is (OM_NEW, OM_SET, OM_UPDATE)
  119.  
  120.         CHECKBOX_TextPlace (WORD)
  121.             Location of checkbox text label. Supports:
  122.  
  123.                 PLACETEXT_RIGHT
  124.                 PLACETEXT_LEFT
  125.  
  126.             Defaults to PLACETEXT_RIGHT.
  127.  
  128.             Applicability is (OM_NEW)
  129. checkbox_gc/CHECKBOX_GetClass                   checkbox_gc/CHECKBOX_GetClass
  130.  
  131.     NAME
  132.         CHECKBOX_GetClass -- Gets the pointer to the checkbox class.
  133.  
  134.     SYNOPSIS
  135.         checkbox_class = CHECKBOX_GetClass();
  136.         D0
  137.  
  138.         Class * CHECKBOX_GetClass(VOID);
  139.  
  140.     FUNCTION
  141.         This function is only available in runtime linked version of the
  142.         class, checkbox.gadget and is not in the compiler linker library
  143.         checkbox_gc.lib.
  144.  
  145.         Obtains the pointer to the CheckBox gadget class for use with
  146.         NewObject().  This function always returns a valid pointer so
  147.         you do not need to check it.  The reason is that if the library
  148.         opens fine, then the pointer returned is already setup.  (Of course
  149.         this implies that if opening the library fails, you shouldn't be
  150.         calling this.)
  151.  
  152.         Note that this function does not create the class, that is done
  153.         when the class library is opened.
  154.  
  155.     INPUTS
  156.         Nothing.
  157.  
  158.     RESULT
  159.         checkbox_class - Pointer to the CheckBox gadget class.
  160.  
  161.     SEE ALSO
  162.